Skip to content

Comprehensive documentation update for HN launch#559

Merged
waleedkadous merged 8 commits intomainfrom
builder/aspir-558-comprehensive-documentation-up
Feb 25, 2026
Merged

Comprehensive documentation update for HN launch#559
waleedkadous merged 8 commits intomainfrom
builder/aspir-558-comprehensive-documentation-up

Conversation

@waleedkadous
Copy link
Contributor

@waleedkadous waleedkadous commented Feb 25, 2026

Summary

Fixes #558. Systematic documentation audit and update across all user-facing docs in preparation for HN launch.

  • Replace all deprecated af dash with af workspace (README, tips, AGENTS.md, CLAUDE.md, MANIFESTO, INSTALL)
  • Add required --protocol flag to af spawn examples
  • Update stale version references from v1.x to v2.x era
  • Modernize Remote Access section (manual SSH → af workspace start --remote)
  • Add 4 new FAQ sections: protocol overview, porch, Agent Farm optionality, remote access
  • Add ASPIR, BUGFIX protocols and porch CLI to cheatsheet
  • Add porch as fourth CLI tool in commands/overview.md
  • Add tips for remote access, cross-workspace messaging, porch checks config
  • Fix stale SP(IDE)R-SOLO and MCP references in why.md

Files Changed

  • README.md — CLI commands, version refs, remote access
  • docs/faq.md — New protocol and feature FAQ sections
  • docs/tips.md — New tips, fixed commands
  • docs/why.md — Fixed stale references
  • codev/resources/cheatsheet.md — Added protocols, porch CLI
  • codev/resources/commands/overview.md — Added porch
  • AGENTS.md / CLAUDE.md — Updated af dash → af workspace (kept in sync)
  • MANIFESTO.md / INSTALL.md — Updated commands

Test plan

  • Verify no af dash references remain in modified files
  • Verify AGENTS.md and CLAUDE.md are byte-identical
  • Verify all af spawn examples include --protocol flag
  • Review each file for internal link consistency

@waleedkadous
Copy link
Contributor Author

waleedkadous commented Feb 25, 2026

Architect Review — Requested Changes

Core changes are solid (af dash → af workspace, version updates, protocol/porch additions). Three corrections needed:

1. Remove --remote flag references

af workspace start --remote user@host does not exist. Remote access is now handled by cloud connectivity (af tower connect). Remove the --remote examples from:

  • README.md Remote Access section
  • docs/faq.md "Can I access Agent Farm remotely?"
  • docs/tips.md "Remote Access" section

Replace with a brief mention of cloud access via af tower connect and codevos.ai, or simply remove the remote access sections if they can't be made accurate.

2. Remove cross-workspace messaging syntax

af send marketmaker:architect "..." is not a real syntax. Remove the "Cross-Workspace Messaging" section from tips.md entirely.

3. Fix af tower register → af tower connect

In cheatsheet.md, change af tower register to af tower connect.

Architect review

@waleedkadous
Copy link
Contributor Author

waleedkadous commented Feb 25, 2026

Architect Review — Approved

All three requested changes addressed correctly:

  1. Remote access now references af tower connect / codevos.ai throughout
  2. Cross-workspace messaging section removed from tips.md
  3. af tower register → af tower connect in cheatsheet

Approved. Please merge.

Architect review

@waleedkadous waleedkadous merged commit 12365d7 into main Feb 25, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Comprehensive documentation update for HN launch

1 participant

@waleedkadous